Add response to UserListsValidation by gmorales96 · Pull Request #417 · cuenca-mx/cuenca-python

gmorales96 · 2025-03-07T23:45:17Z

Description:

This PR adds an optional response: Optional[dict] = None field to the UserListsValidation class. This field will allow storing additional response data related to user list validations.

Changes:

Added response: Optional[dict] = None to UserListsValidation.

Summary by CodeRabbit

New Features
- Enhanced user validation by allowing additional response data for richer feedback.
- Introduced a method to filter user matches based on specific criteria.
Chore
- Updated the application version to 2.1.2.
Tests
- Expanded automated test coverage to verify and support the new validation response capabilities.
- Added assertions to ensure correct behavior of user validation based on new response data.

coderabbitai · 2025-03-07T23:45:35Z

Walkthrough

The changes introduce a new optional attribute response of type Optional[dict] in the UserListsValidation class to allow storing additional response data. A new property method ppe_matches has been added to filter and return a list of persons from the response attribute based on specific criteria. The project version has been updated from 2.1.0 to 2.1.2, with the CLIENT_VERSION adjusted accordingly while the API_VERSION remains unchanged. A new YAML file defining a series of HTTP interactions for user creation validation has been added to support automated testing scenarios. Additionally, a new test function named test_create_user_validation_with_response has been incorporated to verify the behavior of the updated user validation process, along with an assertion added to an existing test function to check the length of ppe_matches.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between c426f1b and 96ffaa7.

📒 Files selected for processing (1)

cuenca/version.py (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

cuenca/version.py

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-03-07T23:46:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4a0c538) to head (96ffaa7).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #417   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           50        50           
  Lines         1118      1124    +6     
=========================================
+ Hits          1118      1124    +6

Flag	Coverage Δ
unittests	`100.00% <100.00%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
cuenca/resources/user_lists_validation.py	`100.00% <100.00%> (ø)`
cuenca/version.py	`100.00% <100.00%> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4a0c538...96ffaa7. Read the comment docs.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…PE-related persons

alexviquez

solo actualiza la versión a la correcta y se va

alexviquez · 2025-03-13T20:19:34Z

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '2.1.0'
+__version__ = '2.1.3.dev0'


bump version

alexviquez · 2025-03-13T20:30:45Z

cuenca/version.py

@@ -1,3 +1,3 @@
-__version__ = '2.1.0'
+__version__ = '2.1.3'


gabino added 2 commits March 7, 2025 17:39

Add response field to UserListsValidation resource

229a928

Bump version to 2.1.1

227fc86

gmorales96 requested a review from alexviquez as a code owner March 7, 2025 23:45

Add ppe_matches property to UserListsValidation class for filtering P…

cd9febf

…PE-related persons

alexviquez suggested changes Mar 13, 2025

View reviewed changes

Bump version to 2.1.3

c426f1b

alexviquez reviewed Mar 13, 2025

View reviewed changes

cuenca/version.py Outdated

@@ -1,3 +1,3 @@

__version__ = '2.1.0'

__version__ = '2.1.3'

Copy link

Contributor

alexviquez Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2.1.1

Bum version to 2.1.2

96ffaa7

alexviquez approved these changes Mar 13, 2025

View reviewed changes

alexviquez merged commit fe2eb3e into main Mar 13, 2025
18 checks passed

alexviquez deleted the feature/add-response-to-userlistsvalidation branch March 13, 2025 20:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add response to UserListsValidation#417

Add response to UserListsValidation#417
alexviquez merged 5 commits intomainfrom
feature/add-response-to-userlistsvalidation

gmorales96 commented Mar 7, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Mar 7, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Mar 7, 2025 •

edited

Loading

Uh oh!

alexviquez left a comment

Uh oh!

alexviquez Mar 13, 2025

Uh oh!

alexviquez Mar 13, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		@@ -1,3 +1,3 @@
		__version__ = '2.1.0'
		__version__ = '2.1.3.dev0'

Conversation

gmorales96 commented Mar 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Changes:

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Mar 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

alexviquez left a comment

Choose a reason for hiding this comment

Uh oh!

alexviquez Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

alexviquez Mar 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gmorales96 commented Mar 7, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 7, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Mar 7, 2025 •

edited

Loading